home *** CD-ROM | disk | FTP | other *** search
/ CD Ware Multimedia 1994 November / Cd Ware (Nro. 2) - Epimundo.iso / DOS / CM / CLCB_111.ZIP / CLCB.DOC < prev    next >
Encoding:
Text File  |  1994-05-25  |  14.5 KB  |  290 lines
  1. ┌─────────────────────────────────────────────────────────────────────────────┐
  2. │ [CLCB]                  Custom Last Caller Bulletin PPE              [CLCB] │
  3. └─────────────────────────────────────────────────────────────────────────────┘
  4.           Custom Last Caller Bulletin PPE (c) 1994 by Midnight Slasher
  5.                         Version: 1.10 Standard / Freeware
  6.                                   - 05/25/94 -
  7. ───────────────────────────────────────────────────────────────────────────────
  8. ───────────────────────────────────────────────────────────────────────────────
  9.                                                               <mslasher@io.org>
  10.  
  11. ───────────────────────────────────────────────────────────────────────────────
  12. [ FILES INCLUDED ] ····························································
  13. ───────────────────────────────────────────────────────────────────────────────
  14.   CLCB.BOT ····· The Last Caller Bulletin Display Footer File
  15.   CLCB.DAT ····· The Last Caller Bulletin Configuration File
  16.   CLCB.DOC ····· The Documentation and Installation Guide
  17.   CLCB.EXC ····· The Exclusion Name List
  18.   CLCB.HST ····· The History/Whats.New File
  19.   CLCB.PPE ····· The Last Caller Bulletin PPE
  20.   CLCB.TOP ····· The Last Caller Bulletin Display Header File
  21.   CLCB.TOT ····· The Last Caller Bulletin 'Totals' File
  22.   FILE_ID.DIZ ·· Description Identification File
  23. ───────────────────────────────────────────────────────────────────────────────
  24.  
  25. ───────────────────────────────────────────────────────────────────────────────
  26. [ PROGRAM SUMMARY ] ···························································
  27. ───────────────────────────────────────────────────────────────────────────────
  28.        These PPEs  (*PCBoard Programming Language Executables*)  generate and
  29.   display a fully sysop configurable last X callers bulletin.  There are many
  30.   last caller  PPEs  available;  but  I have not seen  one that  is quite  as
  31.   configurable as this one.  Header and Footer files are totally configurable
  32.   as well as the actual setup of the last caller  display lines via a  config
  33.   file that uses replacement type codes. (Somewhat like PCBOARD @???@ macros)
  34.   It also  has the ability  to create  and display a  configurable summary of
  35.   today's  and yesterday's activity  (Total  Messages Posted/Files  U/L etc).
  36. ───────────────────────────────────────────────────────────────────────────────
  37.  
  38. ───────────────────────────────────────────────────────────────────────────────
  39. [ INSTALLATION ] ······························································
  40. ───────────────────────────────────────────────────────────────────────────────
  41.  
  42.   This PPE REQUIREs that the PCBSTAT PCBoard Supported Allocation (PSA) be
  43.   installed in your user file.  To do this:
  44.  
  45.    1. Run PCBSM
  46.    2. Press D
  47.    3. Press C
  48.    4. Press E
  49.    5. Press Y to add the PCBSTAT PSA ...
  50.  
  51.   The generator will not function without the PCBSTAT PSA present.
  52.  
  53. ───────────────────────────────────────────────────────────────────────────────
  54.  
  55.   1. Copy all CLCB*.* files to the same directory.
  56.  
  57.   2. Load your PCBTEXT file(s) into MKPCBTXT.EXE
  58.   3. Press F3 and replace prompt #192
  59.  
  60.      Replace the prompt with:       !DRIVE:\PATH\CLCB.PPE /192
  61.                           eg:       !C:\PCB\PPE\CLCB.PPE /192
  62.  
  63.   4. Exit and Save the PCBTEXT file.
  64.  
  65.   5. Place the line:     !DRIVE:\PATH\CLCB.PPE
  66.                  eg:     !C:\PCB\PPE\CLCB.PPE
  67.  
  68.      somewhere in your logon procedure.  You could add this line somewhere
  69.      to your NEWS file, main conference INTRO file, or attached to some other
  70.      PPE.  *It MUST BE RUN every time a user logs on.*  It displays the last
  71.      few callers bulletin, but it also creates a temporary file to store
  72.      the initial stats of a user.  If it is not run, the bulletin will not
  73.      be updated with that caller's information.
  74.  
  75.      If you are unsure of how to make PCBoard show a file only once; here
  76.      is one way to do it.  Run PCBSETUP, press G, press D, and enter "Y"
  77.      on the "Display NEWS file only if changed" prompt.  Then set the file
  78.      date on your NEWS file to a date far in the future (12-12-99).  Edit
  79.      your NEWS file, and on a blank line, insert the !DRIVE:\PATH\CLCB.PPE .
  80.  
  81.      I realize that some people may wish to setup a 'TurboLogin' feature that
  82.      will skip to the main menu without forcing the user to view the last
  83.      few callers bulletin.  If you have a setup such as this; you still
  84.      must run the CLCB.PPE every time a user logs on; but you can use the
  85.      /NOSHOW parameter to only have it create the temporary data file and
  86.      not display anything to the user.  ie:  !C:\PCB\PPE\CLCB.PPE /NOSHOW
  87.  
  88.      Example:  If you do have a TurboLogin feature, just make sure you run
  89.      CLCB.PPE /NOSHOW before the TurboLogin.  You can run CLCB.PPE without
  90.      the /NOSHOW parameter in your login sequence later on (you can run it
  91.      as many times as you want per call) since it will not overwrite the
  92.      temporary data file once it has been created for the caller!
  93.  
  94. ───────────────────────────────────────────────────────────────────────────────
  95.  
  96.  
  97. ───────────────────────────────────────────────────────────────────────────────
  98. [ PROGRAM INFORMATION ] ·······················································
  99. ───────────────────────────────────────────────────────────────────────────────
  100.  
  101.   Once setup; the PPEs are doing the following:
  102.  
  103.   Every time a user logs on; you should somehow have the CLCB.PPE run.  This
  104.   PPE will display the CLCB.TOP file (the header file for the bulletin), the
  105.   CLCB.BLT file (the main bulletin that contains the information of the last
  106.   X callers) and then the CLCB.BOT file (the footer file for the bulletin).
  107.  
  108.   CLCB.TOP = The Header File.  You can also use this file to run any PPEs or
  109.              display any files BEFORE the last caller's bulletin.  You do
  110.              this by putting a line such as:
  111.  
  112.              %C:\PCB\DISPLAY\LOGON.TXT        or
  113.              !C:\PCB\PPE\LOGON.PPE
  114.  
  115.              on any blank line in the CLCB.TOP file.  These should come before
  116.              the graphics of the header for your bulletin.
  117.  
  118.  
  119.   CLCB.BOT = The Footer File.  Just like the CLCB.TOP file, you can run PPEs
  120.              or display other files after the last caller bulletin with this
  121.              file. (Delete it if you don't want a Footer File, deletion works
  122.              with the header file too)
  123.  
  124.  
  125.   CLCB.EXC = The Exclusion List.  If you do not want certain user names to be
  126.              listed in the Last Callers Bulletin, simply add their names (one
  127.              to a line) in this file.
  128.  
  129.  
  130.   CLCB.TOT = The optional file outlay for CLCB.BL2.  This file can use the
  131.              following replacement codes to sum up today's and yesterday's
  132.              total board usage:
  133.  
  134.              %TMPT - Total Messages Posted Today (Not Padded or Justified)
  135.              %TMPY - Total Messages Posted Yesterday         "
  136.  
  137.              %TFUT - Total Files Uploaded Today              "
  138.              %TFUY - Total Files Uploaded Yesterday          "
  139.  
  140.              %TFDT - Total Files Downloaded Today            "
  141.              %TFDY - Total Files Downloaded Yesterday        "
  142.  
  143.              %TKUT - Total Kilobytes Uploaded Today          "
  144.              %TKUY - Total Kilobytes Uploaded Yesterday      "
  145.  
  146.              %TKDT - Total Kilobytes Downloaded Today        "
  147.              %TKDY - Total Kilobytes Downloaded Yesterday    "
  148.  
  149.              CLCB.TOT is the file read into the generator so you can
  150.              customize how you want the output to look.  CLCB.BL2 is the
  151.              file that is output with all the variables converted to their
  152.              appropriate totals.  You can then place CLCB.BL2 (example:
  153.              %C:\PCB\PPE\CLCB\CLCB.BL2) somewhere in your .TOP, or .BOT
  154.              or wherever you want to show the totals for today or
  155.              yesterday's activity.
  156. ───────────────────────────────────────────────────────────────────────────────
  157.  
  158.  CLCB.PPE /192 = This is the PPE Generator mode. It is run as a replacement for
  159.                  prompt 192 in your PCBTEXT file. (It runs when a user logs
  160.                  off the board).  It will look for CLCB.DAT in the same
  161.                  directory that it resides for configuration information.
  162.  
  163. ───────────────────────────────────────────────────────────────────────────────
  164.   CLCB.DAT     = The Configuration File.
  165.  
  166.  
  167. Line 1: Can be:  A one line text message    (eg: the original prompt 192)
  168.             or:  A file to be displayed (eg: %C:\PCB\DISPLAY\GOODBYE.TXT)
  169.             or:  A PPE to be run        (eg: !C:\PCB\PPE\LOGOFF.PPE)
  170.  
  171.  
  172.         Since CLCB_192.PPE replaces PCBTEXT entry #192, this line allows you
  173.         to keep whatever text, PPE or display file that you replaced in the
  174.         PCBTEXT file.
  175.  
  176. Line 2: The number of callers to display in the bulletin.  Must be a number
  177.         less than or equal to 25.  (I doubt you need more, but if you do,
  178.         let me know)
  179.  
  180.         If you wish to list the last 10 callers, place a "10" on this line
  181.         (without the quotes).  The last caller is placed on the top line
  182.         (line 1 of the CLCB.BLT file) and the rest are rotated downwards,
  183.         killing the 11th entry in this case.
  184.  
  185. Line 3: The background color for and character for %FUNCTS (must be one color
  186.         code and one character) Leave this line alone if you do not use the
  187.         %FUNCTS variable.
  188.  
  189.         If you use the %FUNCTS replacement code in line 5 of this file, this
  190.         line specifies the background color and character. These are the filler
  191.         characters used if a function is not filled in for that specific
  192.         user.  (ie: If the user did not Download, a "-" might be displayed
  193.         instead of a "D" in the %FUNCTS macro.)
  194.  
  195. Line 4: The foreground color of any entry in %FUNCTS:
  196.         ie:  --RW---  (the color for R and W)
  197.         Leave this line alone if you do not use the %FUNCTS variable.
  198.  
  199. Line 5: The fully colorized (use PCBoard Codes Only) standard line with CLCB
  200.         replacement codes.
  201.  
  202.         This is where you colorize and configure what you want shown in the
  203.         last caller bulletin.  Replacement Codes begin with a "%" and are
  204.         all listed below.  Think of replacement codes as PCboard Macros.
  205.         As an example: %BAUD will automatically be replaced by the caller's
  206.         connection speed when the bulletin is generated.
  207.  
  208.         This is the best way I could think of to maximize configurability.
  209.         Replacement codes are exactly the same length as the information
  210.         will be once filled in.  IE:  %MO will be filled in with the
  211.         minutes online the user used.  It will be automatically right
  212.         justified and filled to 3 characters.
  213.  
  214.         This line can not exceed 79 uncolorized characters.  This means that
  215.         if you removed all the @X?? codes, it could not exceed 79 characters
  216.         in your text editor.
  217.  
  218. Line 6: [NOT USED] - an uncolorized line to help you see what it will look
  219.                      like, and make sure it fits within 79 characters.
  220. ------------------------------------------------------------------------------
  221.  
  222. REPLACEMENT CODES                                       RJ = Right Justified
  223. -----------------
  224.  
  225. %MIX_USER_FULL_NAME_FIELD  = User's Name in Mixed Characters (Fills 25 Chrs)
  226. %CAP_USER_FULL_NAME_FIELD  = User's Name in CAPITAL LETTERS  (Fills 25 Chrs)
  227.  
  228. %MIX_USERCITYSTATE_FIELD   = User's City/State in Mixed Chrs (Fills 24 Chrs)
  229. %CAP_USERCITYSTATE_FIELD   = User's City/State in CAPITALS   (Fills 24 Chrs)
  230.  
  231. %BAUD                      = Connection Speed of Modem     RJ (Fills 5 Chrs)
  232.  
  233. %MO                        = Minutes Used this Session     RJ (Fills 3 Chrs)
  234.  
  235. %ON24                      = Logon Time in 24hour Format      (Fills 5 Chrs)
  236. %OF24                      = Logoff Time in 24hour Format     (Fills 5 Chrs)
  237.  
  238. %LOGN_AP                   = Logon Time in 12hour A/PM Format (Fills 8 Chrs)
  239. %LOGF_AP                   = Logoff Time in 12hour A/P Format (Fills 8 Chrs)
  240.  
  241. %KBUP                      = Kbytes Uploaded this Session  RJ (Fills 5 Chrs)
  242. %KBDN                      = Kbytes D/loaded this Session  RJ (Fills 5 Chrs)
  243.                                                                             
  244. %SL                        = Security Level of User        RJ (Fills 3 Chrs)
  245.  
  246. %N                         = Node Number                   RJ (Fills 2 Chrs)
  247.  
  248. %U                         = Files Uploaded this Session   RJ (Fills 2 Chrs)
  249.  
  250. %D                         = Files Downloaded this Session RJ (Fills 2 Chrs)
  251.  
  252. %M                         = Messages Posted this Session  RJ (Fills 2 Chrs)
  253.  
  254. %FUNCTS                    = Functions Used this Session      (Fills 7 Chrs)
  255.                              U = Uploaded
  256.                              D = Downloaded
  257.                              W = Posted A Message (Write)
  258.                              R = Read Messages    (Read)
  259.                              N = Node Chat
  260.                              P = Paged Sysop
  261.                              H = Hung Up
  262.  
  263. ───────────────────────────────────────────────────────────────────────────────
  264. [ USAGE ] ·····································································
  265. ───────────────────────────────────────────────────────────────────────────────
  266.   I've tried to make this as easy to use as possible, and as configurable as
  267.   possible.  I'm confident that if you look through the contained files, you
  268.   will be able to figure out how to set it up without any problems.  It is
  269.   in no way crippled, nor is a program name displayed anywhere to the user.
  270.   Log entries (in your caller log) are made when it is run; I put those in
  271.   so you could easily see the version number that is currently installed.
  272.  
  273.   Main points to remember:  CLCB.PPE must be run during the login process of
  274.                             all users.
  275.  
  276.                             PCBTEXT Entry #192 must be replaced with the
  277.                             CLCB.PPE /192
  278.  
  279.                             The PCBSTAT PSA must be installed.
  280.  
  281.  
  282.                        o More to come...
  283.  
  284. ───────────────────────────────────────────────────────────────────────────────
  285.     How to contact the author: Yell real loud, perhaps I'll hear you ...
  286.                            or: mslasher@io.org
  287. ───────────────────────────────────────────────────────────────────────────────
  288. [EOF] ················································· [MS] / Midnight Slasher
  289. ───────────────────────────────────────────────────────────────────────────────
  290.